home *** CD-ROM | disk | FTP | other *** search
/ The PC-SIG Library 10 / The PC-Sig Library - Shareware for the IBM PC and Compatibles (PC-SIG)(Tenth Edition Disks 1-2804)(1991).iso / PC_SIGCD / 04 / 4 / DISK0442.ZIP / SUMMARY.USE < prev    next >
Text File  |  1990-06-14  |  3KB  |  64 lines
  1. SPA:WN is invoked by issuing 'SPAWN <fn>', where fn is the filename of a
  2. file whose filetype is '.WAR', which contains the SPA:WN input file.
  3. For example, to run the provided sample, issue 'SPAWN RODGERS'.
  4.  
  5. The format of the input to SPA:WN is:
  6.  
  7. *Warnier comments can appear anywhere; an "*" in column 1 denotes them.
  8. ([parameter and title records]
  9.    (root node value,repetition field,
  10.       (prefix value,child node value,infix value,)  ...
  11.    prefix value,last child node value,;) ...
  12. ENDWARNIERDIAGRAM) ...
  13.  
  14. The three dots after each level of nested parentheses indicate that
  15. the input at that nested level may be indefinitely repeated in its context.
  16.  
  17. All input must be in hierarchical order; i.e. a node must appear as a
  18. child before it can be repeated in its role as parent (except, of course
  19. the root node for the whole diagram).
  20.  
  21. Repetition and infix fields may be <=12 characters long; the prefix field
  22. may be <=PREWIDTH (default 3) characters long; the node value lengths are
  23. limited by the use of LENLININ (default 80) character-long input records.
  24.  
  25. Parameters are COMMA, SEMI, PERCENT, QUOTE, VERTBAR, TOPBRACK, BOTBRACK,
  26. DIAGCOLS, DIAGPAGEL, ECHOPAGEL, LINEPHYS, LENLINOUT, LENLININ,
  27. NODEWIDTH, PREWIDTH, TOPMARGIN, PLIPUNCH, INDENT, SRCPUNCH, and TITLE.
  28. The first few define character substitutions for the default punctuation
  29. of the input stream.  Later ones (from TOPBRACK through TOPMARGIN)
  30. define output details, and the last four indicate whether to produce
  31. target language code, whether to indent in it and what character to
  32. indent with, whether to produce reordered SPAWN source, and what title
  33. to use in the diagram headers.
  34.  
  35. Structured language contructs (like DO;...END; or IF...ELSE...ENDIF)
  36. appear naturally as parents of trees of nested statements which
  37. constitute their bodies.  The position of appearance of the code of
  38. the body vis-a-vis the characters of the control construct is indicated
  39. by '%---%' (where the '%' may be its substitute), as in DO;%---%END; or
  40. IF...ELSE%---%ENDIF.
  41.  
  42. The comma and semicolon (or their substitutes) delimit the auxiliary fields
  43. and node values in the input stream.  The '%' sign (or its substitute)
  44. forces splitting of the node value in the output diagram; the '"' sign (or
  45. its substitute) delimits disambiguating strings on parent nodes which would
  46. otherwise be indistinguishable.  The vertical bar, the top bracket and the
  47. bottom bracket are used in constructing the brace of the output diagram.
  48.  
  49. Comments in the Warnier input stream are indicated by an '*' in column 1.
  50. They will not appear in the Warnier diagram, but will appear in the *.ECH
  51. file in the input order, and (with the asterisks stripped) collected at the
  52. front of the *.PUN file.  To make them target language comments, the
  53. target language comment delimiters should appear in column 2 or later on the
  54. Warnier comment records.
  55.  
  56. As many as four output files may be obtained from a SPA:WN run, <fn>.ECH,
  57. <fn>.DIA, <fn>.SRC, <fn>.PUN, depending on the parameters and the
  58. presence/absence of errors in the input stream, <fn>.WAR.  The echo file
  59. gives the SPA:WN diagnostics, the diagram file contains the Warnier diagram
  60. (if the input was correct), the source file contains reordered SPA:WN input
  61. (if SRCPUNCH Y was specificed and the input was correct), and the punch file
  62. contains the target language source code (if PLIPUNCH Y was specified and
  63. the input was correct).
  64.